You are here: CSP VoiceXML Platform Implementation Guide > SwitchKit TEP Reference > Inter-Application Messages (InterAppMsg)
Inter-Application Messages (InterAppMsg)
The SwitchKit TEP uses SwitchKit Inter-Application Messages (IAMs) for call signalling. The call processing application you develop must be able to generate or receive the messages in this section. The message format for the InterAppMsg is explained fully in the Excel CSP API Reference Guide.
The format of an IAM is:
The following table explains how the SwitchKit TEP and CP App use the fields. All fields are required.
|
Field |
Description |
|---|---|
|
Target |
Identifier of the application to receive the message. The CP App ID or the TEP ID. |
|
Type |
Indicates the expected behavior of the message. Type is 0xFF (SK_IAM_WITH_NO_ACK): the sender would like to send this message to its destination without expecting an acknowledgement. |
|
Tag1 |
Identifier of the application sending the message |
|
Tag2 |
Hex value that identifies the interapp message. For example, Tag2 = 0x0100 indicates that the IAM_INBOUND_CALL_REQUEST message follows. For a list of IAMs and their corresponding identifiers, see Inbound Messages (to TEP) and Outbound Messages (from TEP to CP App). |
|
Tag3 |
Identifier of the CSP span for the call |
|
Tag4 |
Identifier of the CSP channel for the call |
|
DataSize |
The number of bytes populated in the Data field of the IAM |
|
Data |
Varies by IAM. One or more TLVs that define the data included. For a list of TLVs, see Tag Length Value Blocks. |
The following table lists the IAMs that are sent from the CP App to the TEP. The Data column lists the TLVs used; for a list of TLVs, see Tag Length Value Blocks.
|
Tag2 |
Message |
Data |
|---|---|---|
|
0x0100 |
IAM_INBOUND_CALL_REQUEST |
0x6D67 - Call ID 0x2717 - Called Number 0x2718 - Calling Number |
|
0x0400 |
IAM_TRANSFER_RESULT_STARTED |
0x6D67 - Call ID |
|
0x0401 |
IAM_TRANSFER_RESULT_COMPLETE_COMPLTED |
0x6D67 - Call ID |
|
0x0402 |
IAM_TRANSFER_RESULT_COMPLETE_CANCELED |
0x6D67 - Call ID |
|
0x0403 |
IAM_TRANSFER_RESULT_COMPLETE_FAILED |
0x6D67 - Call ID 0x6D70 - Call Failure Reason |
|
0x0404 |
IAM_TRANSFER_RESULT_FAILED |
0x6D67 - Call ID 0x6D70 - Call Failure Reason |
|
0x0600 |
IAM_TRANSFER_CALL_ABORT_ACK |
0x6D67 - Call ID |
|
0x0800 |
IAM_A_LEG_RELEASED_FAR_SIDE |
0x6D67 - Call ID |
|
0x0801 |
IAM_A_LEG_RELEASED_NEAR_SIDE |
0x6D67 - Call ID |
|
0x0802 |
IAM_A_LEG_RELEASED_BLIND_TRANSFER |
0x6D67 - Call ID |
|
0x0900 |
IAM_B_LEG_RELEASED_FAR_SIDE |
0x6D67 - Call ID |
|
0x0901 |
IAM_B_LEG_RELEASED_NEAR_SIDE |
0x6D67 - Call ID |
|
0x0902 |
IAM_B_LEG_RELEASED_MAX_TIMEOUT |
0x6D67 - Call ID |
|
0x1000 |
IAM_ANSWER |
0x6D67 - Call ID |
|
0x1001 |
IAM_ANSWER_NACK |
0x6D67 - Call ID |
The following table lists the outbound IAMs - those that are sent out from the TEP to the CP App. The Data column lists the TLVs used; for a list of TLVs, see Tag Length Value Blocks.
|
Tag2 |
Message |
Data |
|---|---|---|
|
0x0200 |
IAM_INBOUND_CALL_REQUEST_ACK |
0x6D67 - Call ID 0x6D71 - Inbound Call Request Status |
|
0x0300 |
IAM_TRANSFER_CALL_REQUEST |
0x6D67 - Call ID 0x6D69 - Transfer Destination 0x6D6C - Transfer Type 0x6D6D - Transfer Connect Timeout 0x6D6E - Transfer Max Time Timeout 0x6D6F - Application to Application Info |
|
0x0500 |
IAM_TRANSFER_CALL_ABORT |
0x6D67 - Call ID |
|
0x0700 |
IAM_CALL_RELEASE_REQUEST |
0x6D67 - Call ID |
|
0x0903 |
IAM_CALL_NOT_FOUND |
0x6D67 - Call ID 0x6D71 - Inbound Call Request Status |
|
0x1100 |
IAM_REFUSE |
0x6D67 - Call ID 0x6D72 - Refuse Reason |